Readme

Contents

• Web Browser
  • JavaScript
  • WebRTC
• Web Server
  • Application Pool Identity
• iCMS Connection
• Microsoft Authentication
• User Account Control
• Diagnostics

Web Browser

JavaScript

In order to use the ARIA Click, ARIA Touch or ARIA Hoot web applications, JavaScript must be enabled on the client web browser.

WebRTC

In order to use the ARIA Click, ARIA Touch or ARIA Hoot web applications, the client web browser must be capable of supporting WebRTC. At the time of authoring this includes the Google Chrome, Microsoft Edge (Chromium-based) and Mozilla Firefox web browsers.

Web Server

IIS Application Pool Identities

It is recommended that the identity used by the IIS application pools are only configured by the iWS software installation program. If the identities of the application pools are manually changed (post-install) then the account used for each application pool (ARIAClickAppPool, ARIATouchAppPool, ARIAHootAppPool and AYREAppPool) needs to be:

1. Given read/write permissions to %INSTALLDIR%\LogFiles.
2. Given full control permissions to all existing WebApp.log files in the %INSTALLDIR%\LogFiles folder.
3. Given read/write permissions to %INSTALLDIR%\WebOptimizerCache.

iCMS Connection

The iWS web applications connect to the iCMS, by default, on port 443. If the iCMS has been configured with custom port numbers the iWS will need to be configured to match. This can be done during installation of the iWS by adding a port number to the iCMS API URL, e.g. "https://hostname:443/icms/api", or to change them manually (post-install) then:

1. Open the relevant config file(s) in a text editor, e.g. notepad.
   • ARIA Click - %INSTALLDIR%\ARIAClick\appsettings.json
   • ARIA Touch - %INSTALLDIR%\ARIATouch\appsettings.json
   • ARIA Hoot - %INSTALLDIR%\ARIAHoot\appsettings.json
   • AYRE - %INSTALLDIR%\AYRE\appsettings.json
2. Find the cmsApiUrl setting and add or change the port number, e.g. "https://hostname:443/icms/api"

Microsoft Authentication

To use Microsoft Azure Entra (Azure AD) authentication, application registrations (for the iCMS API and the ARIA/AYRE web applications) need to be configured in Microsoft Azure by an appropriate administrator. Configuration within Azure is not covered by this readme.

If configured within Azure before installation then they can be entered during iWS installation/upgrade. If configured within Azure after installation of the iWS, then configuration parameters from Azure need to be configured manually for the iWS web applications:

1. Open the relevant config file(s) in a text editor, e.g. notepad.
   • ARIA Click - %INSTALLDIR%\ARIAClick\appsettings.json
   • ARIA Touch - %INSTALLDIR%\ARIATouch\appsettings.json
   • ARIA Hoot - %INSTALLDIR%\ARIAHoot\appsettings.json
   • AYRE - %INSTALLDIR%\AYRE\appsettings.json
2. Find the oidcApplicationId setting and set the value to the application (client) id from the ARIA/AYRE app registration in Azure, e.g.
   "oidcApplicationId": "abcdef12-1234-abcd-5678-fedbca654321"
3. Find the oidcAuthority setting and set the value to the issuer authority, where the GUID is the tenant id from Azure, e.g.
   "oidcAuthority": "https://login.microsoftonline.com/aabbcc11-1122-aabb-5566-ffeeddcc2211/v2.0"
4. Find the oidcCmsApiScope setting and set the value to the iCMS API scope as defined in the iCMS API app registration, e.g.
   "oidcCmsApiScope": "api://11111122-3331-abcd-edfa-eeaabb1166cc/SoftClient"

User Account Control

If the User Account Control feature of Windows is being used the user may be prompted to allow the iWS software installation program to run and make changes on the system. The iWS software installation program must be run using an Administrator account, or using the Run as administrator feature of Windows.

Diagnostics

Server Diagnostics

For the purpose of diagnosing issues with the software or installation, log files are written to the LogFiles folder, located underneath the installation target folder:

• ARIAClickWebApp.log - Logging information from the iWS server software for the ARIA Click web application.
• ARIATouchWebApp.log - Logging information from the iWS server software for the ARIA Touch web application.
• ARIAHootWebApp.log - Logging information from the iWS server software for the ARIA Hoot web application.
• AYREWebApp.log - Logging information from the iWS server software for the AYRE web application.
• Install.log - Logging information from the iWS software installation program.

Browser Application Diagnostics

The ARIA Click, ARIA Touch and ARIA Hoot web applications store their own logging information which is also output to the browser console. This log can be downloaded via the web application user interface. Note: Additional logging can be enabled within the web applications and may be required when diagnosing issues.

When reporting issues back to Speakerbus Technology Ltd, please include these log files. In certain circumstances it may also be necessary to return as additional information, to aid the diagnostic process, the Windows System and Application Event Logs as well as a backup of the iCMS database.

AYRE User Interface Diagnostics

The AYRE web application logging information should be downloaded, via TFTP, using the usual device log upload mechanisms available in iCMS or directly from the AYRE device. Note: Additional logging can be enabled within the web applications and may be required when diagnosing issues.